|
| English |
| Version 1.1.3 |
General Commands • Version Special Menus /xpopup Command • -b • -c • -d • -i • -j • -l • -p • -s • -t • -x $xpopup Identifier • ismenu • style • exstyle • colors • color /xpop Command • -a • -c • -d • -f • -i • -s • -t $xpop Identifier • num • text • icon • checked • enabled • submenu XPopup Item Path XPopup Events |
This DLL lets you build nice stylish popup menus to be used everywhere in your script including coloring mIRC's own popup menus.  These general commands are used in the xpopup extension. This command lets you get information on the DLL like version number and state. Command: //echo -a $dll( xpopup.dll, Version, . ) There are two XPopup special menus. They are mIRC's regular popup menus (channel, statusbar, query and nicklist) and mIRC's menubar popup menus which include (menubar). The use the reserved menu names mirc and mircbar. They can be activated with the following command : Command: /mpopup [mirc|mircbar] [1|0] Both menus can have their style, colors and icons modified using the /xpopup command. The command switches -c/-d are disabled for these menus. You can't use /xpop to modify these menus either. To add icons the mIRC's popups menus (status, menubar, channel, query and nicklist) you need to add the icons the menu image lists using /xpopup -i/-j. The icon index number needs to be inserted in the mIRC popup menu syntax like this : Syntax: [$style()] [ICON] [VTAB] [Item Text] [TAB] [Accelerator Text] : [mIRC Command] Parms :
N.B. Accelerator text is usually a shortcut key combination to the same command seen in the menu that which the text is right aligned in the menu item like the CTRL-H seen in the image below. Remember that the same mIRC popup rules still apply. It is only the menu item text syntax that needs to be shaped for XPopup to interpret it correctly. If the [VTAB] element is not present, XPopup assumes that the item text is a regular no icon element. You can also add $idents in you menu item text like mIRC has always permitted to create your own tri-state check system for example with the use of custom icons. The image below is an example of a mIRC menubar popup menu skinned with XPopup which includes icons.  The /xpopup command is used to create/modify/destroy an XPopup menu. This command lets you set the menu item background image in CUSTOM style. Please take note that the image is stretched to fit the menu item rectangle. Only BMP images are supported through this command. Command: /xpopup -b [MENU] [IMAGE] Example: /xpopup -b mymenu $mircdirmc.bmp This command lets you create an XPopup empty menu. Xpopup menus are permanent until destroyed with /xpopup -d or the DLL is unloaded. Command: /xpopup -c [MENU] [STYLE] Example: /xpopup -c mymenu office2003rev Parms :
This command lets you destroy an XPopup empty menu. Command: /xpopup -d [MENU] Example: /xpopup -d mymenu This command lets you add an icon to the menu image list. Command: /xpopup -i [MENU] [INDEX] [FILENAME] Example: /xpopup -i mymenu 113 C:/mIRC/shell.dll Parms :
This command lets you clear the menu image list. Command: /xpopup -j [MENU] Example: /xpopup -j mymenu This command lets you set the Nth color in the menu as given by the order listed in /xpopup -p. Command: /xpopup -l [MENU] [N] [COLOR] Example: /xpopup -l mymenu 2 $rgb(255,0,0) This command lets you set the whole menu color palette in one command where [COLORS] is a space separated list of RGB colors. Command: /xpopup -p [MENU] [COLORS] Example: /xpopup -p mymenu $rgb(255,0,0) $rgb(0,0,255) ... Parms :
This command lets you display a menu. Command: /xpopup -s [MENU] [+FLAGS] [X] [Y] Example: /xpopup -s mymenu + 100 100 Parms :
This command lets you change the menu style. Command: /xpopup -t [MENU] [STYLE] Example: /xpopup -t mymenu officexp This command lets you set the menu extended styles. Command: /xpopup -x [MENU] [+FLAGS] Example: /xpopup -x mymenu +dp Parms :
The $xpopup identifier is a given mIRC alias that communicates with the XPopup DLL to extract information from XPopup menus. This property retrieves if a menu exists. Identifier: $xpopup(menu).ismenu Example: //echo -a $xdialog(mymenu).ismenu This property retrieves the menu style. Identifier: $xpopup(menu).style Example: //echo -a $xdialog(mymenu).style This property retrieves the menu extended styles. Identifier: $xpopup(menu).exstyle Example: //echo -a $xdialog(mymenu).exstyle This property retrieves the menu colors as one line (see /xpopup -p for the list). Identifier: $xpopup(menu).colors Example: //echo -a $xdialog(mymenu).colors This property retrieves Nth menu color (see /xpopup -p for the list). Identifier: $xpopup(menu, N).color Example: //echo -a $xdialog(mymenu).color The /xpop command is used to add/modify/remove menu items in XPopup menus. This command lets you add a menu item. Command: /xpop -a [MENU] [N N .. N] [TAB] [+FLAGS] [ID] [ICON] ItemText Example: /xpop -a mymenu 1 0 $chr(9) + 1 1 Menu Item 1 Parms :
N.B. A menu item that has a checkmark and an icon displays the icon instead of the checkmark. N.B. Remember to use mIRC's $eval(expression,0) to prevent the mIRC evaluation of the $idents that your text contains. This command lets you create a submenu on a menu item. Command: /xpop -c [MENU] [N N .. N] Example: /xpop -c mymenu 1 1 N.B. If the item already has a submenu, it is destroyed. This can be used to clear a submenu instead of deleting the whole menu item. This command lets you destroy a submenu on a menu item. Command: /xpop -d [MENU] [N N .. N] Example: /xpop -d mymenu 1 1 This command lets you delete a menu item. Command: /xpop -f [MENU] [N N .. N] Example: /xpop -f mymenu 1 1 This command lets you change the icon on a menu item. Command: /xpop -i [MENU] [N N .. N] [TAB] [ICON] Example: /xpop -i mymenu 1 1 $chr(9) 3 This command lets you change the state flags on an item (see /xpop -a for the switches). Command: /xpop -s [MENU] [N N .. N] [TAB] [+FLAGS] Example: /xpop -s mymenu 1 1 $chr(9) +cg This command lets you change a menu item text. Command: /xpop -t [MENU] [N N .. N] [TAB] ItemText Example: /xpop -t mymenu 1 1 $chr(9) $eval($me,0) N.B. Remember to use mIRC's $eval(expression,0) to prevent the mIRC evaluation of the $idents that your text contains. The $xpop identifier is a given mIRC alias that communicates with the XPopup DLL to extract information in XPopup menu items.) This property retrieves the number of menu items in a submenu. Identifier: $xpop(menu, N N .. N).enabled Example: //echo -a $xpop(mymenu, 4).enabled N.B. The path N N .. N can be root to the number of items on the root menu. This property retrieves the menu item text. Identifier: $xpop(menu, N N .. N).text Example: //echo -a $xpop(mymenu, 4).text This property retrieves the menu item icon index number. Identifier: $xpop(menu, N N .. N).icon Example: //echo -a $xpop(mymenu, 4).icon This property retrieves if a menu item is checked or not. Identifier: $xpop(menu, N N .. N).checked Example: //echo -a $xpop(mymenu, 4).checked This property retrieves if a menu item is enabled or disabled. Identifier: $xpop(menu, N N .. N).enabled Example: //echo -a $xpop(mymenu, 4).enabled This property retrieves if a menu item has a submenu or not. Identifier: $xpop(menu, N N .. N).submenu Example: //echo -a $xpop(mymenu, 4).submenu The xpopup menus have an engin that parses the given item "path" data to know where to insert/delete/modify a given item in the menu structure. The parameters you supply are a space separated numerical token list of the menu submenus that lead to the menu item position : Format: N N N ... N For example : 2 3 This position represents the 3rd menu item of the of the second menu item submenu as shown by the selected item in the picture below:  N.B. You can use 0 for the last value when inserting a menu item to insert it at the end of the menu. Events are sent through mIRC's ON SIGNAL event with the signal name being xpopup-[MENU] where [MENU] is the menu name that sent the event. The $1 parameter is the supplied [ID] of the menu item and you see why it's important that this number be unique. A returned value of 0 means no selection was made in the menu. - Development -> ClickHeRe - General Testing -> bl0x - #scriptsdb.org @ Undernet @ Webnet - http://scriptsdb.org |